Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: change PaymentPreimage to PaymentSecret in ChannelManager::create_inbound_payment #2846

Closed
wants to merge 1 commit into from
Closed

doc: change PaymentPreimage to PaymentSecret in ChannelManager::create_inbound_payment #2846

wants to merge 1 commit into from

Conversation

vladimirfomene
Copy link
Contributor

Docs mentioned create_inbound_payment returns PaymentHash and PaymentPreimage when it instead returns PaymentHash and PaymentSecret.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 23, 2024 •
edited
Loading

Walkthrough

The update involves a correction in the documentation of a method within the channel manager module. The method create_inbound_payment_for_hash now has an updated comment that accurately describes its functionality—it generates a PaymentHash and a PaymentSecret for the user, rather than a PaymentHash and a PaymentPreimage.

Changes

File Path Change Summary
.../ln/channelmanager.rs Updated method comment to correctly describe generated items

🐇
In the code, a tiny change we weave,
A comment corrected, misconceptions leave.
Hash and secret, now in pair,
The rabbit coder fixed it with care. 🥕

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@vladimirfomene vladimirfomene changed the title doc: change PaymentPreimage to PaymentSecret doc: change PaymentPreimage to PaymentSecret in ChannelManager::create_inbound_payment Jan 23, 2024
coderabbitai[bot]
coderabbitai bot reviewed Jan 23, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4bab9c8 and ff7c39b.
Files selected for processing (1)
  • lightning/src/ln/channelmanager.rs (1 hunks)
Additional comments: 1
lightning/src/ln/channelmanager.rs (1)
  • 7835-7835: The comment has been updated to reflect that create_inbound_payment_for_hash generates a PaymentHash and PaymentSecret. This aligns with the PR objectives and the AI-generated summary.

jkczyz
jkczyz reviewed Jan 23, 2024
View reviewed changes
lightning/src/ln/channelmanager.rs
Comment on lines 7834 to +7835
/// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
/// [`PaymentHash`] and [`PaymentPreimage`] for you.
/// [`PaymentHash`] and [`PaymentSecret`] for you.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs are correct as is. This isn't saying that the PaymentPreimage is returned but rather it is generated in LDK. It's essentially encoded in the PaymentSecret such that inbound payments in LDK are stateless when using create_inbound_payment.

Using create_inbound_payment_for_hash allows you to generated your own preimage, but you would need to track it in order to call claim_funds.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will close this PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any suggestions on how to improve these docs for clarity are welcome, of course!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jkczyz jkczyz jkczyz left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vladimirfomene @jkczyz